home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / os2 / sslog12.zip / SSLOGGER.HLP (.txt) < prev    next >
OS/2 Help File  |  1996-10-20  |  19KB  |  392 lines

  1.  
  2. ΓòÉΓòÉΓòÉ 1. Introduction ΓòÉΓòÉΓòÉ
  3.  
  4. SSLogger is a native OS/2 logger designed specifically for the ARRL November 
  5. Sweepstakes.  This logger includes the following features: 
  6.  
  7.      Dupe Checking. 
  8.      Log window that contains a scrollable list of log records though which 
  9.       previously-written log records can be edited. 
  10.      Section window that tracks sections worked. 
  11.      Status window which shows various contest statistics. 
  12.      Break Records.  SSLogger can record breaks taken during the course of a 
  13.       contest. 
  14.      Built-in transceiver control for the Kenwood TS-940S. 
  15.      Facility to export the log to ARRL Suggested Standard File Format. 
  16.  
  17.  
  18. ΓòÉΓòÉΓòÉ 2. Installation and Configuration ΓòÉΓòÉΓòÉ
  19.  
  20. To install SSLogger, perform the following steps: 
  21.  
  22.      Unzip the file SSLog11.zip.  As usual, place the .dll files in some 
  23.       subdirectory included in your LIBPATH, the .exe and .cmd files in some 
  24.       subdirectory in your PATH, SSLogger.hlp in some directory specified by 
  25.       HELP, and SSLogger.inf in some directory specifed by BOOKSHELF.  The 
  26.       values for LIBPATH, PATH, HELP, and BOOKSHELF typically are all set in 
  27.       config.sys. 
  28.  
  29.      From the same subdirectory in which SSLogger.exe resides, execute 
  30.       SSCrIcon.cmd to create an SSLogger icon on your desktop.  You can move 
  31.       this icon to any folder you choose.  After you create the icon, bring up 
  32.       the Settings notebook (reached by pointing to the icon with the mouse and 
  33.       clicking button 2) and specify as the working directory the directory 
  34.       where you want to store your log files by default.  Of course, the 
  35.       directory specified must exist.  If you execute SSCrIcon.cmd from a 
  36.       subdirectory other than the subdirectory that contains SSLogger.exe, the 
  37.       path to SSLogger.exe will also need to be corrected. 
  38.  
  39.      Specify in config.sys the directory in which you want to store 
  40.       SSLOGGER.INI. SSLOGGER.INI is used to save various settings, and you 
  41.       typically will want to use those settings regardless of which directory 
  42.       you invoke SSLogger.exe from.  Its location can be specified by setting 
  43.       SSLOGGER_INI to the desired subdirectory.  A good place to store 
  44.       SSLOGGER.INI would be the same directory that contains SSLogger.exe. If 
  45.       SSLogger.exe is contained in the directory c:\bin, for instance, the 
  46.       following line would be added to config.sys: 
  47.  
  48.             SET SSLOGGER_INI=c:\bin
  49.  
  50.       If you do not set SSLOGGER_INI, the current directory is used. 
  51.  
  52.  
  53. ΓòÉΓòÉΓòÉ 3. Running SSLogger ΓòÉΓòÉΓòÉ
  54.  
  55. SSLogger.exe is the logger program.  It can be executed in the following ways: 
  56.  
  57.      Double-clicking on the SSLogger icon.  See the section on Installation 
  58.       and Configuration for instructions on how to create an SSLogger icon. 
  59.  
  60.      Double-clicking on a Sweepstakes Log icon for an existing log file.  This 
  61.       icon can be accessed by viewing the folder that contains the log file. 
  62.  
  63.      From the command line simply by entering sslogger. 
  64.  
  65.  Tip:  CrLog.exe, described below, can be used to create a sample log for you. 
  66.        Please read the notes on CrLog.exe before executing it. 
  67.  
  68.  
  69. ΓòÉΓòÉΓòÉ 4. Creating and Opening a Log ΓòÉΓòÉΓòÉ
  70.  
  71. To create a log, select the File->Create menu option from the SSLogger main 
  72. window.  Before the prompt for the file name, a succession of three dialog 
  73. boxes will appear, from which SSLogger will obtain information necessary to 
  74. create the log. 
  75.  
  76.      Contest Information.  This dialog box is used to obtain contest dates and 
  77.       times, and the contest mode.  The contest times are for documentation 
  78.       only and do not impose any limits which log data times must fall within. 
  79.  
  80.      Station Info.  Via this dialog box, provide station info, e.g., callsign, 
  81.       precedence, check, and section. 
  82.  
  83.      Time Setup.  SSLogger does not require you to set your system clock to 
  84.       UTC.  Use this dialog box to indicate your system clock's offset from 
  85.       from UTC.  For example, EST would be -5.  SSLogger uses this information 
  86.       to convert times based on your system clock to UTC. 
  87.  
  88.  These dialogs can also be accessed at any time under the Settings menu option. 
  89.  
  90.  To open a log file later, select the File->Open menu option, or open the 
  91.  folder that contains the log file and double-click on the log file's icon. 
  92.  
  93.  
  94. ΓòÉΓòÉΓòÉ 5. Logging Contacts ΓòÉΓòÉΓòÉ
  95.  
  96. Log records are entered from the SSLogger main window. Before you can log any 
  97. contacts, you first must create or open a log file. Having done that, you must 
  98. then begin contest operation. The actual operation begin and end times are used 
  99. for statistics.  To begin operation, select the Actions->Contest 
  100. Operation->Begin menu option. Select Actions->Contest Operation->Terminate when 
  101. you are finished with the contest. Of course, you can change your mind and 
  102. select Actions->Contest Operation->Begin again to continue operating, in which 
  103. case, a break record will be written to record the interval of no contest 
  104. operation.  Make sure that you select Actions->Contest Operation->Terminate 
  105. when you're finished operating, so that the statistics presented in the Status 
  106. window are accurate. However, if you do forget, the operation times are 
  107. editable, and the statistics are adjusted accordingly. 
  108.  
  109. The operation period can be edited at any time with the Edit Operation Time 
  110. dialog box, accessible via Actions->Contest Operation->Edit Contest Operation 
  111. Time menu option.  Note that dates and times cannot be changed so as to 
  112. conflict with other log data already recorded. 
  113.  
  114. Once you have begun contest operation, you can log contacts.  Select the proper 
  115. band and fill in the log data into the SSLogger main window entry fields. You 
  116. can tab and backtab through the fields.  The space bar also acts as a tab.  The 
  117. Esc key will clear the current field data.  Pressing Esc again will clear all 
  118. of the fields and place the cursor in the Callsign field.  F12 will clear all 
  119. of the fields and place the cursor in the Callsign field.  Press F4 or the 
  120. Enter key to log the contact. 
  121.  
  122. A dupe check will be performed if you change the Callsign field as soon as you 
  123. tab out of the field, or if you press F4 or the Enter key to log the entry. If 
  124. a dupe check detects a dupe, a message box will pop up and give you the option 
  125. to cancel the entry (the normal case) or to force the log entry.  If you force 
  126. the log entry, no points will be scored for the previous log entry for that 
  127. callsign. 
  128.  
  129. To change bands, use the Ctrl+Tab key to tab to and from the Band control. 
  130.  
  131.  
  132. ΓòÉΓòÉΓòÉ 6. Editing Log Records ΓòÉΓòÉΓòÉ
  133.  
  134. Log records can be edited from the Log window. To edit a log record, make that 
  135. record the highlighted entry and press the Enter key, the Edit pushbutton, or 
  136. simply double-click on the desired log record entry.  A dialog box will the pop 
  137. up and allow you to change any log record field. 
  138.  
  139. The date/time of a log entry cannot be updated so that it falls within the 
  140. range of a break already recorded. Similarly, it must fall within the Operation 
  141. Begin and Operation Terminate times. If contest operation is in progress, the 
  142. log entry date/time cannot fall before Operation Begin. 
  143.  
  144. Finally, the log record date/time must fall between the previous entry and the 
  145. next entry in order to preserve the sequential nature of the log. 
  146.  
  147. The band entry in a range of records can be edited in one operation from the 
  148. Range Edit: Band dialog box.  This feature exists in case the operator is not 
  149. using transceiver control and forgets to change the band on the logger. From 
  150. the Range Edit: Band dialog, the operator enters the contact numbers for the 
  151. beginning and ending log records in the range to be edited and selects the 
  152. correct band.  The default beginning contact number is the that of the log 
  153. record currently highlighted in the log list, and the default ending contact 
  154. number is that of the last log record in the log.  Updates to large blocks of 
  155. records may take several seconds, but once the update is initiated, you can 
  156. return to the main SSLogger window and resume logging.  An individual log 
  157. record can be updated while the range update is in progress, as long the record 
  158. is outside the range being updated. The Range Edit: Band dialog box can be 
  159. reached by selecting the Range Edit->Band menu option in the Log window. 
  160.  
  161.  
  162. ΓòÉΓòÉΓòÉ 7. Recording Breaks ΓòÉΓòÉΓòÉ
  163.  
  164. ARRL requires you to indicate all breaks taken during the contest.  To begin a 
  165. break, select the Actions->Break->Begin menu option in the SSLogger main 
  166. window.  During a break, logging is disabled.  To end a break, select 
  167. Actions->Break->Terminate, and logging is then re-enabled. 
  168. Actions->Break->Cancel can be used to cancel a break in progress.  The break 
  169. menu options are disabled until Actions->Contest Operation->Begin has been 
  170. selected. If you select Actions->Contest Operation->Terminate and later decide 
  171. to continue operation and select Actions->Contest Operation->Begin, a break 
  172. record will be written for that period of no operation.  Breaks of any length 
  173. may be recorded, but ARRL only counts breaks of 30 minutes or more.  Thus, the 
  174. Status window only counts breaks of at least 30 minutes.  Similarly, the log 
  175. exported to ARRL Suggested File Format will only show breaks of sufficient 
  176. duration. 
  177.  
  178. Breaks may be listed and edited with the Edit Break Times dialog box. You can 
  179. bring up this dialog by selecting Actions->Breaks->Edit Break Times.  Note that 
  180. break times cannot be updated so as to conflict with other log data already 
  181. recorded. For example, it would be an error to edit a break period so that a 
  182. log record already written falls within that interval.  Similarly, the break 
  183. must fall within the time of operation. 
  184.  
  185.  
  186. ΓòÉΓòÉΓòÉ 8. Windows ΓòÉΓòÉΓòÉ
  187.  
  188. SSLogger provides three windows in addition to the main window, which can be 
  189. left up while using the logger: 
  190.  
  191.      Log Window.  Contains a scrollable list of log records. Log records can 
  192.       be edited from this list. 
  193.  
  194.      Section Window.  Contains a list of sections that indicates which 
  195.       sections have been worked. 
  196.  
  197.      Status Window.  Displays various contest statistics. 
  198.  
  199.  These windows are always kept up-to-date.  A window may be minimized and 
  200.  redisplayed by selecting it from the Windows menu option again or by pressing 
  201.  its respective "fast-path" key, shown along with its menu option title.  All 
  202.  window positions and sizes (if resizable) are automatically saved so that the 
  203.  windows always come up in the arrangement you have selected.  Options specific 
  204.  to a given window are also automatically saved. 
  205.  
  206.  
  207. ΓòÉΓòÉΓòÉ 8.1. Log Record Window ΓòÉΓòÉΓòÉ
  208.  
  209. The log record list in the Log window can be used to scroll through records in 
  210. the log.  Log records may be edited from this window. To display the Log 
  211. window, select the Windows->Log menu option of the main SSLogger window. 
  212.  
  213. Included in the log record list is a column with the heading of Dupe.  This 
  214. column is normally blank.  If a log entry was forced, creating a "dupe" entry 
  215. (see Logging Contacts), the entry is marked as such with a Y in the Dupe 
  216. column.  This means that the contact is a duplicate and no points have been 
  217. scored for the contact, and of course, is not counted in the Section window or 
  218. the Stats window. 
  219.  
  220. The Log window is resizable.  To set the vertical size of the Log window, 
  221. position the mouse pointer to the bottom border of the Log window and drag it 
  222. until the window is the desired height.  The amount of desktop space consumed 
  223. can be reduced by making the Log window height no larger than required. 
  224. Similarly, the Log window width can be adjusted.  The relative sizes of the 
  225. columns in the list are preserved, so you might be able to save a little 
  226. desktop space by squeezing in the columns a little. 
  227.  
  228. Log records can be edited from the log list.  Please refer to the section 
  229. entitled "Editing Log Records" for details. 
  230.  
  231. Log Window Options 
  232. Log window options can be accessed through the Options menu option. Option 
  233. choices are automatically saved and used in subsequent logging sessions. 
  234.  
  235. Font 
  236. The font for the log record list can be changed.  Using the smallest font that 
  237. you can comfortably read can save a lot of desktop space over the system font, 
  238. which is the default.  To change the font, select the Options->Font menu 
  239. option. 
  240.  
  241. Tip:  Alt+L provides a quick way to access the Log window. You can leave it on 
  242.       your desktop, minimize it, or close it, although reopening the window 
  243.       will take longer if it is closed. Alt+M can be used to quickly return to 
  244.       the main window. 
  245.  
  246.  
  247. ΓòÉΓòÉΓòÉ 8.2. Section Window ΓòÉΓòÉΓòÉ
  248.  
  249. The section list can be used to track sections worked and to look up the 
  250. correct abbreviation.  To display the Section window, select Section under the 
  251. Windows menu option in the SSLogger main window. 
  252.  
  253. Sections not yet worked are colored blue, while sections already worked are 
  254. "de-highlighted" with a more subdued gray color. 
  255.  
  256. Section Window Options 
  257. The Section window has different options available.  They can be accessed 
  258. through the Options menu option.  Option choices are automatically saved and 
  259. used in subsequent logging sessions. 
  260.  
  261. Font 
  262. The font for the Section window can be changed.  Using the smallest font that 
  263. you can comfortably read can save a lot of desktop space over the system font, 
  264. which is the default.  To change the font, select the Options->Font menu 
  265. option. 
  266.  
  267. Columns 
  268. The number of columns in the Section window can be set in order to achieve the 
  269. desired window dimensions. 
  270.  
  271. Section Abbrev's Only 
  272. By default, the section list includes section names and abbreviations, and is 
  273. sorted by section name.  This can be useful for abbrev lookups during phone 
  274. contests. In CW contests, the section name is not really necessary.  The 
  275. Section Abbrev's Only option can be used to display only the section 
  276. abbreviations, sorted by abbreviation, to make the Section window require much 
  277. less desktop space. 
  278.  
  279. Tip:  Alt+S provides quick access to the Section window. You can leave it on 
  280.       your desktop, minimize it, or close it. Use Alt+M to quickly return to 
  281.       the main window. 
  282.  
  283.  
  284. ΓòÉΓòÉΓòÉ 8.3. Status Window ΓòÉΓòÉΓòÉ
  285.  
  286. The Status window displays current statistics, including number of 
  287. contacts/hour, contact count, section count, score, time off, actual time spent 
  288. operating, and total time (op time + break time). Only breaks of at least the 
  289. minimum duration allowed by ARRL are reflected in the break time.  Similarly, a 
  290. break in progress is not reflected until its duration reaches the minimum 
  291. allowed. 
  292.  
  293. Tip:  Alt+T provide quick access to the Status window. You can leave it on your 
  294.       desktop, minimize it, or close it. Use Alt+M to quickly return to the 
  295.       main window. 
  296.  
  297.  
  298. ΓòÉΓòÉΓòÉ 9. Transceiver Control ΓòÉΓòÉΓòÉ
  299.  
  300. If you have a Kenwood TS-940S with the option for computer control, you can let 
  301. SSLogger perform some control and monitoring.  First, you need to perform some 
  302. basic setup. Select the Xcvr->Settings menu option in the SSLogger main window 
  303. to bring up the Transceiver Settings dialog box. 
  304.  
  305. In the Transceiver Settings dialog box, set the Serial Port spin button to the 
  306. serial port your transceiver is connected to. You will also find a list of 
  307. frequencies, one per band per mode.  These frequencies are used by SSLogger 
  308. when you switch bands using the Band control in the SSLogger main window.  When 
  309. you have selected a new band, the transceiver switches to the corresponding 
  310. frequency displayed in the Transceiver Settings dialog.  SSLogger is constantly 
  311. monitoring your current frequency.  You can opt to switch back to the most 
  312. recently used frequency for a band if you check the checkbox with a like 
  313. heading in the Transceiver Settings dialog box. 
  314.  
  315. If you use the transceiver to change to another band, SSLogger will 
  316. automatically update the logger band setting accordingly. 
  317.  
  318. Connect to the transceiver by selecting Xcvr->Connect->Kenwood TS940. You can 
  319. disconnect from the transceiver by selecting Xcvr->Disconnect. 
  320.  
  321. Note:  There is a bug in the TS940S computer control firmware (even the latest 
  322.        update) which causes the transceiver to momentarily transmit on the 
  323.        received frequency when the T/R relay is closed while the transceiver is 
  324.        communicating with the computer. 
  325.  
  326. Release 1.0 of SSLogger polled the transceiver four times per second, which 
  327. caused annoying results, since the operator usually has the RIT control set to 
  328. a non-zero offset.  The bug is particularly annoying when operating CW in 
  329. break-in mode!  To alleviate the problem, SSLogger now polls once every 20 
  330. seconds. If you use the transceiver to change bands (although changing bands 
  331. with the logger is better), there will usually be a short delay before the band 
  332. on the logger is updated accordingly.  SSLogger's saving the last frequency 
  333. used is similarly affected. 
  334.  
  335.  
  336. ΓòÉΓòÉΓòÉ 10. Exporting to ARRL Suggested Standard File Format ΓòÉΓòÉΓòÉ
  337.  
  338. The ARRL accepts log entries in ARRL Suggested Standard File Format on diskette 
  339. or via internet.  To produce a copy of your log in ARRL Suggested Standard File 
  340. Format, open your log file and select the File->Export to ARRL Format menu 
  341. option.  In the ensuing dialog box, enter the desired file name or use the 
  342. default provided. The resulting file is an editable ASCII file.  The start and 
  343. end of each break of sufficient duration (at least 30 minutes) that has been 
  344. recorded in the log is reflected by the log records in the ASCII file that 
  345. bracket the break. 
  346.  
  347.  
  348. ΓòÉΓòÉΓòÉ 11. Creating a Sample Log File ΓòÉΓòÉΓòÉ
  349.  
  350. CrLog.exe has been included to generate relatively quickly a large log of 1000 
  351. records that you can use to familiarize yourself with the various SSLogger 
  352. functions. 
  353.  
  354. CrLog.exe has one parameter:  the computer clock's offset relative to UTC.  For 
  355. example, if the computer clock is set to CST, invoke CrLog as follows: 
  356.  
  357. crlog -6
  358.  
  359. For maximum data integrity, SSLogger uses synchronous writes so that data is 
  360. written immediately--not buffered and written whenever the filesystem driver 
  361. decides to write the data.  This means that you should be able to press 
  362. Ctrl-Break at any time during the execution of CrLog.exe and end up with a 
  363. consistent log.  The last contact logged will appear in the log unless the 
  364. write operation to disk did not complete. This also means that CrLog will run 
  365. very slowly.  Of course, in normal operation, you are not writing such large 
  366. amounts of data so quickly and you should not notice a significant performance 
  367. degradation. 
  368.  
  369.  
  370. ΓòÉΓòÉΓòÉ 12. Author Comments ΓòÉΓòÉΓòÉ
  371.  
  372. I offer SSLogger as freeware and am asking for no fees or donations. I hope you 
  373. enjoy SSLogger and find it useful and effective in your November Sweepstakes 
  374. Contest operation. If you would like to be notified of updates, please send me 
  375. e-mail at the address given below.  I welcome any comments and suggestions. 
  376.  
  377.    Will Edwards, WA5WZA
  378.    14803 Chicadee Circle
  379.    Pflugerville, TX 78660-8168
  380.    edwardsw@bga.com
  381.  
  382.  
  383. ΓòÉΓòÉΓòÉ <hidden>  ΓòÉΓòÉΓòÉ
  384.  
  385. For more information on the November Sweepstakes contest, or about amateur 
  386. radio in general, contact: 
  387.  
  388.       American Radio Relay League 
  389.       225 Main St. 
  390.       Newington, CT 06111-1494 
  391.  
  392.       http://www.arrl.org